Resource URL: /platform/<<version=1>>/auth/providers/ldap/<ID>

    Overview: This resource applies the standard collection pattern to
              individual LDAP providers.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the LDAP provider.

       URL: GET /platform/<<version=1>>/auth/providers/ldap/<ID>

Query arguments:
scope=<enum> Where <enum> is one of user, default, effective.  If specified as
             "effective" or not specified, all fields are returned.  If
             specified as "user", only fields with non-default values are
             shown.  If specified as "default", the original values are
             returned.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "ldap": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the properties for the LDAP authentication provider.", 
            "properties": {
              "cn_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the canonical name.", 
                "maxLength": 255
              }, 
              "group_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for this provider through which groups are qualified.", 
                "maxLength": 255
              }, 
              "netgroup_triple_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP Netgroup Triple attribute.", 
                "maxLength": 255
              }, 
              "group_filter": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP filter for group objects.", 
                "maxLength": 255
              }, 
              "system": {
                "type": [
                  {
                    "type": "boolean", 
                    "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed."
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "login_shell": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the login shell path.", 
                "maxLength": 4096
              }, 
              "unique_group_members_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Sets the LDAP Unique Group Members attribute.", 
                "maxLength": 255
              }, 
              "base_dn": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the root of the tree in which to search identities.", 
                "maxLength": 255
              }, 
              "group_base_dn": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", 
                "maxLength": 255
              }, 
              "netgroup_base_dn": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", 
                "maxLength": 255
              }, 
              "id": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the ID of the LDAP provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "gid_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP GID attribute.", 
                "maxLength": 255
              }, 
              "provider_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the provider domain.", 
                "maxLength": 255
              }, 
              "uid_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the the LDAP UID Number attribute.", 
                "maxLength": 255
              }, 
              "member_of_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", 
                "maxLength": 255
              }, 
              "bind_timeout": {
                "minimum": 1, 
                "type": "integer", 
                "description": "Specifies the timeout in seconds when binding to an LDAP server.", 
                "maximum": 3600
              }, 
              "unfindable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies users that cannot be resolved by the provider.", 
                "maxItems": 4294967295
              }, 
              "listable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the groups that can be viewed in the provider.", 
                "maxItems": 4294967295
              }, 
              "bind_dn": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the distinguished name for binding to the LDAP server.", 
                "maxLength": 255
              }, 
              "netgroup_search_scope": {
                "enum": [
                  "default", 
                  "base", 
                  "onelevel", 
                  "subtree", 
                  "children"
                ], 
                "type": "string", 
                "description": "Specifies the depth from the base DN to perform LDAP searches."
              }, 
              "authentication": {
                "type": "boolean", 
                "description": "If true, enables authentication and identity management through the authentication provider."
              }, 
              "email_attribute": {
                "minLength": 4, 
                "type": "string", 
                "description": "Specifies the LDAP Email attribute.", 
                "maxLength": 64
              }, 
              "restrict_findable": {
                "type": "boolean", 
                "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
              }, 
              "server_uris": {
                "minItems": 1, 
                "items": {
                  "minLength": 4, 
                  "type": "string", 
                  "maxLength": 2048
                }, 
                "type": "array", 
                "description": "Specifies the server URIs.", 
                "maxItems": 4294967295
              }, 
              "status": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the status of the provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "search_timeout": {
                "minimum": 10, 
                "type": "integer", 
                "description": "Specifies the search timeout period in seconds.", 
                "maximum": 3600
              }, 
              "gecos_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP GECOS attribute.", 
                "maxLength": 255
              }, 
              "home_directory_template": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to the home directory template.", 
                "maxLength": 4096
              }, 
              "findable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the list of users that can be resolved.", 
                "maxItems": 4294967295
              }, 
              "group_members_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP Group Members attribute.", 
                "maxLength": 255
              }, 
              "crypt_password_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the hashed password value.", 
                "maxLength": 255
              }, 
              "alternate_security_identities_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the attribute name used when searching for alternate security identities.", 
                "maxLength": 255
              }, 
              "user_search_scope": {
                "enum": [
                  "default", 
                  "base", 
                  "onelevel", 
                  "subtree", 
                  "children"
                ], 
                "type": "string", 
                "description": "Specifies the depth from the base DN to perform LDAP searches."
              }, 
              "user_domain": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for this provider through which users are qualified.", 
                "maxLength": 255
              }, 
              "unfindable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the groups that cannot be resolved by the provider.", 
                "maxItems": 4294967295
              }, 
              "enumerate_users": {
                "type": "boolean", 
                "description": "If true, allows the provider to enumerate users."
              }, 
              "netgroup_members_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP Netgroup Members attribute.", 
                "maxLength": 255
              }, 
              "unlistable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a user that cannot be listed by the provider.", 
                "maxItems": 4294967295
              }, 
              "homedir_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP Homedir attribute.", 
                "maxLength": 255
              }, 
              "normalize_groups": {
                "type": "boolean", 
                "description": "Normalizes group names to lowercase before look up."
              }, 
              "restrict_listable": {
                "type": "boolean", 
                "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
              }, 
              "enumerate_groups": {
                "type": "boolean", 
                "description": "If true, allows the provider to enumerate groups."
              }, 
              "shell_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the the LDAP Shell attribute.", 
                "maxLength": 255
              }, 
              "search_scope": {
                "enum": [
                  "base", 
                  "onelevel", 
                  "subtree", 
                  "children"
                ], 
                "type": "string", 
                "description": "Specifies the default depth from the base DN to perform LDAP searches."
              }, 
              "ntlm_support": {
                "enum": [
                  "all", 
                  "v2only", 
                  "none"
                ], 
                "type": "string", 
                "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
              }, 
              "name": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the name of the LDAP provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "ignore_tls_errors": {
                "type": "boolean", 
                "description": "If true, continues over secure connections even if identity checks fail."
              }, 
              "user_base_dn": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", 
                "maxLength": 255
              }, 
              "unlistable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies a group that cannot be listed by the provider.", 
                "maxItems": 4294967295
              }, 
              "balance_servers": {
                "type": "boolean", 
                "description": "If true, connects the provider to a random server."
              }, 
              "listable_users": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the users that can be viewed in the provider.", 
                "maxItems": 4294967295
              }, 
              "enabled": {
                "type": "boolean", 
                "description": "If true, enables the LDAP provider."
              }, 
              "nt_password_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP NT Password attribute.", 
                "maxLength": 255
              }, 
              "check_online_interval": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the time in seconds between provider online checks.", 
                "maximum": 3600
              }, 
              "bind_mechanism": {
                "enum": [
                  "simple", 
                  "gssapi", 
                  "digest-md5"
                ], 
                "type": "string", 
                "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value."
              }, 
              "name_attribute": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP UID attribute, which is used as the login name.", 
                "maxLength": 255
              }, 
              "require_secure_connection": {
                "type": "boolean", 
                "description": "Determines whether to continue over a non-TLS connection."
              }, 
              "netgroup_filter": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP filter for netgroup objects.", 
                "maxLength": 255
              }, 
              "findable_groups": {
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "maxLength": 255
                }, 
                "type": "array", 
                "description": "Specifies the list of groups that can be resolved.", 
                "maxItems": 4294967295
              }, 
              "user_filter": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the LDAP filter for user objects.", 
                "maxLength": 255
              }, 
              "normalize_users": {
                "type": "boolean", 
                "description": "Normalizes user names to lowercase before look up."
              }, 
              "group_search_scope": {
                "enum": [
                  "default", 
                  "base", 
                  "onelevel", 
                  "subtree", 
                  "children"
                ], 
                "type": "string", 
                "description": "Specifies the depth from the base DN to perform LDAP searches."
              }, 
              "certificate_authority_file": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to the root certificates file.", 
                "maxLength": 4096
              }, 
              "create_home_directory": {
                "type": "boolean", 
                "description": "Automatically create the home directory on the first login."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the LDAP provider.

       URL: PUT /platform/<<version=1>>/auth/providers/ldap/<ID>

Query arguments:
force=<boolean> Ignore unresolvable server URIs.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for the LDAP authentication provider.", 
  "properties": {
    "cn_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the canonical name.", 
          "maxLength": 255
        }
      ]
    }, 
    "group_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the domain for this provider through which groups are qualified.", 
          "maxLength": 255
        }
      ]
    }, 
    "netgroup_triple_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP Netgroup Triple attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "group_filter": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP filter for group objects.", 
          "maxLength": 255
        }
      ]
    }, 
    "login_shell": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the login shell path.", 
          "maxLength": 4096
        }
      ]
    }, 
    "unique_group_members_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Sets the LDAP Unique Group Members attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "base_dn": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the root of the tree in which to search identities.", 
          "maxLength": 255
        }
      ]
    }, 
    "group_base_dn": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", 
          "maxLength": 255
        }
      ]
    }, 
    "netgroup_base_dn": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", 
          "maxLength": 255
        }
      ]
    }, 
    "gid_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP GID attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "provider_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the provider domain.", 
          "maxLength": 255
        }
      ]
    }, 
    "uid_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the the LDAP UID Number attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "member_of_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", 
          "maxLength": 255
        }
      ]
    }, 
    "bind_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1, 
          "type": "integer", 
          "description": "Specifies the timeout in seconds when binding to an LDAP server.", 
          "maximum": 3600
        }
      ]
    }, 
    "unfindable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies users that cannot be resolved by the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "listable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies the groups that can be viewed in the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "bind_dn": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the distinguished name for binding to the LDAP server.", 
          "maxLength": 255
        }
      ]
    }, 
    "netgroup_search_scope": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "default", 
            "base", 
            "onelevel", 
            "subtree", 
            "children"
          ], 
          "type": "string", 
          "description": "Specifies the depth from the base DN to perform LDAP searches."
        }
      ]
    }, 
    "authentication": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables authentication and identity management through the authentication provider."
        }
      ]
    }, 
    "bind_password": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the password for the distinguished name for binding to the LDAP server.", 
          "maxLength": 255
        }
      ]
    }, 
    "email_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 4, 
          "type": "string", 
          "description": "Specifies the LDAP Email attribute.", 
          "maxLength": 64
        }
      ]
    }, 
    "restrict_findable": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups."
        }
      ]
    }, 
    "server_uris": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 1, 
          "items": {
            "minLength": 4, 
            "type": "string", 
            "maxLength": 2048
          }, 
          "type": "array", 
          "description": "Specifies the server URIs.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "search_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 10, 
          "type": "integer", 
          "description": "Specifies the search timeout period in seconds.", 
          "maximum": 3600
        }
      ]
    }, 
    "gecos_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP GECOS attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "home_directory_template": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the path to the home directory template.", 
          "maxLength": 4096
        }
      ]
    }, 
    "findable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies the list of users that can be resolved.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "group_members_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP Group Members attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "crypt_password_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the hashed password value.", 
          "maxLength": 255
        }
      ]
    }, 
    "alternate_security_identities_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the attribute name used when searching for alternate security identities.", 
          "maxLength": 255
        }
      ]
    }, 
    "user_search_scope": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "default", 
            "base", 
            "onelevel", 
            "subtree", 
            "children"
          ], 
          "type": "string", 
          "description": "Specifies the depth from the base DN to perform LDAP searches."
        }
      ]
    }, 
    "user_domain": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the domain for this provider through which users are qualified.", 
          "maxLength": 255
        }
      ]
    }, 
    "unfindable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies the groups that cannot be resolved by the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "enumerate_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allows the provider to enumerate users."
        }
      ]
    }, 
    "netgroup_members_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP Netgroup Members attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "unlistable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies a user that cannot be listed by the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "homedir_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP Homedir attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "normalize_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Normalizes group names to lowercase before look up."
        }
      ]
    }, 
    "restrict_listable": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups."
        }
      ]
    }, 
    "enumerate_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, allows the provider to enumerate groups."
        }
      ]
    }, 
    "shell_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the the LDAP Shell attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "search_scope": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "base", 
            "onelevel", 
            "subtree", 
            "children"
          ], 
          "type": "string", 
          "description": "Specifies the default depth from the base DN to perform LDAP searches."
        }
      ]
    }, 
    "ntlm_support": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "v2only", 
            "none"
          ], 
          "type": "string", 
          "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials."
        }
      ]
    }, 
    "name": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the name of the LDAP provider.", 
      "maxLength": 255
    }, 
    "ignore_tls_errors": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, continues over secure connections even if identity checks fail."
        }
      ]
    }, 
    "user_base_dn": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", 
          "maxLength": 255
        }
      ]
    }, 
    "unlistable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies a group that cannot be listed by the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "balance_servers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, connects the provider to a random server."
        }
      ]
    }, 
    "listable_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies the users that can be viewed in the provider.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables the LDAP provider."
        }
      ]
    }, 
    "nt_password_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP NT Password attribute.", 
          "maxLength": 255
        }
      ]
    }, 
    "check_online_interval": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the time in seconds between provider online checks.", 
          "maximum": 3600
        }
      ]
    }, 
    "bind_mechanism": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "simple", 
            "gssapi", 
            "digest-md5"
          ], 
          "type": "string", 
          "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value."
        }
      ]
    }, 
    "name_attribute": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP UID attribute, which is used as the login name.", 
          "maxLength": 255
        }
      ]
    }, 
    "require_secure_connection": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Determines whether to continue over a non-TLS connection."
        }
      ]
    }, 
    "netgroup_filter": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP filter for netgroup objects.", 
          "maxLength": 255
        }
      ]
    }, 
    "findable_groups": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies the list of groups that can be resolved.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "user_filter": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the LDAP filter for user objects.", 
          "maxLength": 255
        }
      ]
    }, 
    "normalize_users": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Normalizes user names to lowercase before look up."
        }
      ]
    }, 
    "group_search_scope": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "default", 
            "base", 
            "onelevel", 
            "subtree", 
            "children"
          ], 
          "type": "string", 
          "description": "Specifies the depth from the base DN to perform LDAP searches."
        }
      ]
    }, 
    "certificate_authority_file": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the path to the root certificates file.", 
          "maxLength": 4096
        }
      ]
    }, 
    "create_home_directory": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Automatically create the home directory on the first login."
        }
      ]
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the LDAP provider.

          URL: DELETE /platform/<<version=1>>/auth/providers/ldap/<ID>

There are no query arguments for this method.

There is no JSON response body for this method.
